package edu.mtu.citizenscience.mushroommapper.json;

import edu.mtu.citizenscience.mushroommapper.json.fieldguide.GuideMushroom;


/**
 * @author Corbin Uselton <corbinu@cwuselto@mtu.edu>
 * @copyright (c) 2012 MichiganTech <http://www.mtu.edu>
 * @since 1.0
 * 
 * Field Guide object used by Jackson JSON to load in
 * the field_guide.json file
 */
public class FieldGuide {
	// the field guide data version
	private int version;
	// array of field guide mushrooms in the field guide data file
	private GuideMushroom[] mushrooms;

	/**
	 * Get the field guide data version
	 * 
	 * @param   void
	 * @return	int - the data version
	 */
	public int getVersion() 
	{
		return version;
	}
	
	/**
	 * Set the field guide data version
	 * 
	 * @param   int - the data version
	 * @return	void
	 */
	public void setVersion(int version) 
	{
		this.version = version;
	}

	/**
	 * Get the field guide mushrooms
	 * 
	 * @param   void
	 * @return	GuideMushroom[] - the field guide mushrooms
	 */
	public GuideMushroom[] getMushrooms() 
	{
		return mushrooms;
	}
	
	/**
	 * Set the field guide mushrooms
	 * 
	 * @param   GuideMushroom[] - the field guide mushrooms
	 * @return	void
	 */
	public void setMushrooms(GuideMushroom[] mushrooms)
	{
		this.mushrooms = mushrooms;
	}

}
